Progress Tracker iPart

With the Progress Tracker iPart, you can visually display progress towards a goal based on the results of an IQA query. For example, connect this iPart to a fundraising query, so that your members can easily track the progress of a fundraising effort towards a specific goal. Or connect it to an events query, so that you can see at a glance how many people have registered for an event.

To set up the Progress Tracker

1.  Create a query for the Progress Tracker.

Note: For sample queries that work with this iPart, see $/Samples/ProgressTracker/ in IQA.

The Progress Tracker uses three pieces of information supplied by an IQA query: a goal amount, the sum total of what you are tracking, and the end date (which is optional). When you build your query for this iPart, it must contain specific aliases. In IQA, create a new query and choose the business object you want to query on. Make sure you are in Advanced Mode, then from the Display tab, choose properties to assign the following aliases to:

□    Goal_Amount: Indicates which property is the goal amount. You can apply this alias to a property of a business object, or apply it to a Custom SQL Expression property. For example, add CAST(25000 AS INT) as a property to set the goal amount to 25,000.

□    Sum_Total: Indicates which property is the amount to be summed. The percentage displayed in the Progress Tracker is based on this amount compared to the goal. It can be a monetary amount or any other number, such as the number of event registrations.

Tip: From the Function dropdown list for this property, select Sum, so that only one row is sent to the iPart. This is not required, but it will improve performance.

□    End_Date: Indicates which property specifies the end date. This alias is only required if you want to display an end date in the iPart. You can apply this alias to a property of a business object, or apply it to a Custom SQL Expression property. For example, add CAST('2012-12-25' AS DATE) as a property to set the end date to 25 December, 2012.

2.  Add the iPart to a content record and configure it.

□    From Content designer > Manage content, edit or create a content record.

□    Add the Progress Tracker iPart.

□    Enter the iPart CSS class to style the Progress Tracker. Two styles have been pre-defined that you can use in the iPart: ProgressTracker and ProgressTracker2. You can edit these classes to change the look and feel, or you can create your own style for the Progress Tracker.

□    Select a Source query.

□    (optional) Select a data column by which you want to filter. You can use this feature to dynamically update your Progress Tracker, based on the value passed to it in the URL. If you choose to filter on a data column, then also enter the name of the URL parameter, which the iPart uses to identify the value to filter on. For example, to limit the results of an event query to a specific event, you can select the EventCode property and give the URL parameter a name such as EventCode. The progress displayed will then reflect only the event code which is included in the URL as EventCode=[EventCodeValue].

□    (optional) Enter any messages you want to appear in the iPart. The variables below can be used in the descriptions. For example, "Help us reach our goal of {0} new members by {2}!"

■    {0} displays the goal total

■    {1} displays the current sum total or count

■    {2} displays the end date in a long format

■    {3} displays the end date in a short format

□    Select the Caption Options. In addition to the progress bar, you can also display the values as text. If any of the Caption Options are unavailable after selecting a query, that means the required aliases have not been defined in the query.

□    Select the Progress bar location. The bar can be displayed above or below the captions.

Note: You can also use this iPart to display only a countdown (days remaining to a certain date). In configuration, only select the caption option Display days remaining, then for the Progress bar location, select (None).